/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.basics.manager;

import javax.mail.MessagingException;

import org.springframework.mail.javamail.MimeMessageHelper;

/**
 * This manager handle mails sending.
 */
public interface MailHandlerManager
{

  /**
   * Create a {@link MimeMessageHelper} based on the MIME message.
   * 
   * @return a {@link MimeMessageHelper}
   */
  public abstract MimeMessageHelper newMimeMessageHelper();
  
  /**
   * Create a {@link MimeMessageHelper} based on the MIME message. 
   * @param multipart
   *            if true, supports alternative texts, inline elements and attachments
   * @return a {@link MimeMessageHelper}
   * @throws MessagingException 
   *              if an error occur
   */
  public abstract MimeMessageHelper newMimeMessageHelper(boolean multipart) throws MessagingException;
  
  /**
   * Create a {@link MimeMessageHelper} based on the MIME message. 
   * @param multipart
   *            if true, supports alternative texts, inline elements and attachments
   * @param encoding
   *             character encoding
   * 
   * @return a {@link MimeMessageHelper}
   * @throws MessagingException 
   *              if an error occur
   */
  public abstract MimeMessageHelper newMimeMessageHelper(boolean multipart, String encoding) throws MessagingException;



  /**
   * Send the MIME message.
   * 
   * @param mimeMessage
   *          the message to send
   */
  public abstract void sendMail(MimeMessageHelper mimeMessage);
  
 
}
